home *** CD-ROM | disk | FTP | other *** search
/ Directorty Opus 5 - Magellan 2 / Opus 5 - Magellan 2.iso / Extras / xPackGauge / xPackGauge.doc < prev    next >
Text File  |  1995-04-22  |  3KB  |  98 lines
  1.  
  2.     xPackGauge - a frontend for the XPK libraries
  3.      (written by Daniel Balster in February 1994)
  4.      
  5. >    WHAT IS IT ?
  6.     
  7.     xPackGauge is a CLI command that is able to pack/unpack files
  8.     using the XPK libraries. if you don't know what XPK is, stop here
  9.     and inform yourself about it.
  10.  
  11.     xPackGauge was mainly written to perfectly fit into DirectoryOpus (4.xx)
  12.     from InovaTronics. It's easy to install it to a button and all your
  13.     packing-jobs are quite easy now!
  14.     
  15.     You can invoke it from a shell; never do this. Use xPack or any
  16.     other tool like that instead! xPackGauge should only be used within
  17.     DirOpus.
  18.     
  19. >    READ THIS, TOO
  20.  
  21.     aerh, unfortunately the source of this tool has gone to NIL: or so.
  22.     i wrote this tool more than a year ago and spreaded it arround to
  23.     some friends. since then the tool is in heavy use and noone would
  24.     miss it. they always boggled me to change the layout/design of this
  25.     helpful tool and implement a better error handling; i never did it,
  26.     i couldn't find the source... (and it's to boring to rewrite it
  27.     before there really is a need to do that)
  28.  
  29.     -> if you think there is a need then contact me (drop me a mail)
  30.        and tell me - i might spent some time to it again ;-)
  31.  
  32. >    ERROR-HANDLING AND AVOIDING
  33.  
  34.     luckily, i experienced NEVER a really bad error. the program uses
  35.     safe-packing and safe-unpacking, that means a file named TEST will
  36.     be (un)packed to TEST.tmp and after that TEST will be deleted and
  37.     then TEST.tmp will be renamed to TEST.tmp.
  38.     if the filename of TEST is longer than 160 characters it could be
  39.     that the .tmp file couldn't be created! important: make sure that
  40.     TEST has the D protection flag set; else TEST couldn't be deleted
  41.     and TEST.tmp couldn't be renamed and so on. be warned!
  42.     (of course xPackGauge could set the +D flag before, but for that
  43.     i need my source... grrr)
  44.  
  45.     rule: never pack longnamed, non-deletable files ;-)
  46.  
  47. >    INSTALLATION
  48.  
  49.     -    copy xPackGauge somewhere to your path, i.e. C:
  50.     (i myself hold it in DOPUS:C/xPackGauge)
  51.     
  52.     -    Start DirectoryOpus and go into the Configuration Manager.
  53.     
  54.     You now have to add custom buttons. Read the manual to know
  55.     how to manage this!
  56.     
  57. NAME    TYPE        ENTRY
  58.     
  59. xunpack    (AmigaDOS)    xPackGauge FILE {f}
  60. xpkNUKE    (AmigaDOS)    xPackGauge FILE {f} METHOD NUKE MODE 100 PACK SKIP
  61. xpkSQSH    (AmigaDOS)    xPackGauge FILE {f} METHOD SQSH MODE 100 PACK SKIP
  62. .    .        .
  63. .    .        .
  64. .    .        .
  65.  
  66.     .. and so on, i think you got it.
  67.     
  68.     xPackGauge has the following command line options:
  69.     
  70.     "FILE,METHOD,PASSWORD,MODE,PUBSCREEN,PACK/S,SKIP/S"
  71.  
  72.     FILE        the filename of the file to be packed/unpacked.
  73.     
  74.     METHOD        4-Character XPK ID (case sensitive)
  75.     
  76.     PASSWORD    a password string (if supported by the packer)
  77.     
  78.     MODE        packer rate in percent: could be 0..100
  79.     
  80.     PACK        this tells xPackGauge it should pack the data
  81.             (default is unpacking)
  82.     
  83.     SKIP        if the ratio is less than 5% then packing will
  84.             be aborted and nothing will be packed. important!
  85.     
  86.     PUBSCREEN    default is the Workbench screen, enter DOPUS.1 or
  87.             so if you like.
  88.  
  89. >    LAST
  90.  
  91. i hope this is enough information to you. tell me if not (i wrote this
  92. little intro in about 10 minutes)
  93.  
  94. some notes: sorry for the hardcoded topaz/8 and the useless progress data
  95. below the gauge...
  96.  
  97. a new version would take a day or so - but i have not the time, yet.
  98.